Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

In line code comment documentation #152

Merged
merged 3 commits into from
Nov 29, 2023
Merged

Conversation

kele-leanes
Copy link
Contributor

This PR adds in-line comments to the methods of the classes Client, Conversation, and Conversations.

This may help the integrators have more context about every method and also generate the docs for GH pageas easily.

example
Screenshot 2023-11-21 at 10 52 34

link to issue

@kele-leanes kele-leanes self-assigned this Nov 21, 2023
@kele-leanes kele-leanes requested a review from a team as a code owner November 21, 2023 13:56
Copy link
Contributor

@nplasterer nplasterer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 👍

@kele-leanes kele-leanes merged commit 3a4f98d into main Nov 29, 2023
3 of 4 checks passed
@kele-leanes kele-leanes deleted the kele/code-comment-documentation branch November 29, 2023 19:00
Copy link
Contributor

github-actions bot commented Dec 2, 2023

🎉 This PR is included in version 1.21.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants